         **************************************************************
         *       Magic Knight Rayearth - Un-Worked Design Patch       *
         *                 Version 0 (15 Mar. 2017)                   *
         *            by Supper (suppertails66@gmail.com)             *
         **************************************************************

This is a patch that fixes many issues introduced in the US version of the Sega 
Saturn game Magic Knight Rayearth by its publisher, Working Designs. The US 
release drastically cranks up the game's difficulty by making nearly all the 
enemies faster and their attacks much more damaging. This patch restores the 
original difficulty from the Japanese version.

              ****************************************************
              *                     Changes                      *
              ****************************************************

* All enemies and their attacks do the damage they did in the Japanese version.
* Enemy speeds have been reduced to their original levels.

Other changes in the US version (e.g. the extra save files, the removed voice 
acting, the horrible horrible made-up script) have been kept.

For specific details on the alterations in the US version, see this page (though 
it may not have been written yet at the time you're reading this): 
https://tcrf.net/Magic_Knight_Rayearth_(Sega_Saturn)

              ****************************************************
              *               Patching Instructions              *
              ****************************************************

--- WHAT YOU'LL NEED ---
* A BIN/CUE or ISO/WAV format disc image of the US version of Magic Knight 
Rayearth (Sega Saturn).
* If you're on Windows, the xdelta patching utility (http://xdelta.org/) is 
provided in this distribution. On other platforms, you'll need to acquire 
version 3.0.8 or later on your own.

--- AUTOMATIC PATCHING METHOD (WINDOWS) ---

If you're using Windows, move your disc image files into the same directory as 
the program and do one of these as appropriate:
  * If you have a BIN/CUE disc image, drag and drop the BIN file (or IMG file) 
onto binpatch.bat.
  * If you have an ISO/WAV disc image, drag and drop the ISO file onto 
isopatch.bat. Note that your ISO/WAV files must use standard naming and 
numbering, e.g. "File 01.iso", "File 02.wav", etc.

If everything works, this should produce the patched game under the name 
"MagicKnightRayearthUnWorked_##". To play it, open 
MagicKnightRayearthUnWorked_01.iso in your emulator of choice. A .CUE file is 
also included for completeness, but you shouldn't need it unless you intend to 
burn the game to disc for use on a modded Saturn. (In fact, most Saturn 
emulators won't even load a multi-file CUE like this one.)

If this doesn't work, try using the manual patching method below to diagnose the 
problem.

--- MANUAL PATCHING METHOD---

--- CONVERTING FROM BIN/CUE TO ISO ---
If you have a BIN/CUE image (or the equivalent IMG/CUE), you'll need to convert 
it to ISO/WAV before you can patch it. I'd recommend using BinChunker (a.k.a. 
bchunk -- homepage http://he.fi/bchunk/) to do this.

* On Windows, you can use the included bchunk.exe (courtesy of elmer). If you 
don't want to use bchunk, there are also many "shareware"/commercial utilities 
that can do this task, though they may or may not output the same ISO as bchunk.
* On Linux, it should be available from your distro's repos, or of course you 
can build from source.
* On Mac, you can build from source, or perhaps get binaries wherever Mac people 
get their binaries from.

To convert, open a command prompt and navigate to the folder containing the 
BIN/CUE, then run the following command:

bchunk -w MagicKnightRayearthUS.bin MagicKnightRayearthUS.cue 
MagicKnightRayearthUS_

(substituting the names of your BIN/CUE files, obviously -- remember to put 
quotes around them if they have spaces in them. **Don't rename them** -- this 
will cause the conversion to fail unless you also modify the CUE file itself.) 
This should generate two files: MagicKnightRayearthUS_01.iso and 
MagicKnightRayearthUS_02.wav.

--- PATCHING STEPS---
1. First, !!!***verify that your ISO has the correct MD5 hash***!!! It should be 
731199f110c2cd84edecada000cafc89. If it isn't, the patch almost certainly won't 
work. You can obtain this by using the md5sum utility on *nix, or the FCIV 
utility (https://support.microsoft.com/en-us/kb/889768) on Windows.

2. Use xdelta to apply MagicKnightRayearthUnWorked.xdelta to your ISO. If you're 
using the command line, this would look something like:

xdelta3 -d -s MagicKnightRayearthUnWorked.xdelta MagicKnightRayearthUS_01.iso 
MagicKnightRayearthUnWorked_01.iso

If you use a GUI wrapper, it should be self-explanatory, but make sure the 
output file is named MagicKnightRayearthUnWorked_01.iso.

3. That's technically all the patching required. If you're playing on an 
emulator, the ISO is all you need, since this game doesn't use CD audio in-game. 
If you have a modded Saturn and intend to burn the game to a disc to play it on 
hardware, you should rename the audio track produced by bchunk to 
MagicKnightRayearthUnWorked_02.wav, then use the included 
MagicKnightRayearthUnWorked.cue file to burn the disc. (Note that I don't have a 
modded Saturn and haven't tested this.)

--- TROUBLESHOOTING ---
* If your emulator won't run the included CUE file after applying the patch, try 
opening the ISO directly instead, as the most popular Saturn emulators don't 
support multi-file CUEs like this one.
* If the automatic patching method fails to produce any audio files, make sure 
all your files are named in the format "Filename ##.wav". The patcher expects to 
see a two-digit number directly before the file extension; without that, it 
can't find the tracks.
* If the patched ISO won't run, check the MD5 hash of your original ISO. The 
correct hash is given in step 1 above. If either of them doesn't match, try a 
different method for converting the BIN/CUE to ISO, or using a BIN/CUE generated 
by a different program.

              ****************************************************
              *                  Known Issues                    *
              ****************************************************

None, yet...

              ****************************************************
              *                 Version History                  *
              ****************************************************
  
Version 0 (3/15/17)
  * Initial release.

              ****************************************************
              *                  Special Thanks                  *
              ****************************************************

* elmer
* Everyone on ROMhacking.net who provided feedback and support
